# Copyright (c) 2021 Arm Limited
# All rights reserved.
#
# The license below extends only to copyright in the software and shall
# not be construed as granting a license to any other intellectual
# property including but not limited to intellectual property relating
# to a hardware implementation of the functionality of the software
# licensed hereunder.  You may use the software subject to the license
# terms below provided that you ensure that this notice is replicated
# unmodified and in its entirety in all distributions of the software,
# modified or unmodified, in source code or in binary form.
#
# Copyright (c) 2008 The Hewlett-Packard Development Company
# Copyright (c) 2018 Metempsy Technology Consulting
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from m5.params import *
from m5.SimObject import SimObject


class TypeTLB(ScopedEnum):
    """
    instruction: TLB contains instruction entries only
    data: TLB contains data entries only
    unified: TLB contains both instruction and data entries

    The enum values have been selected in order to perform bitwise
    operations on them. For example a unified TLB contains both
    instruction and data entries so code trying to assess if the
    TLB is storing (e.g.) data entries can do that with:

    bool has_data = tlb->type() & TypeTLB::data;
    """

    map = {"instruction": 0x1, "data": 0x2, "unified": 0x3}


class BaseTLB(SimObject):
    type = "BaseTLB"
    abstract = True
    cxx_header = "arch/generic/tlb.hh"
    cxx_class = "gem5::BaseTLB"

    # Ports to connect with other TLB levels
    cpu_side_ports = VectorResponsePort("Ports closer to the CPU side")
    slave = DeprecatedParam(
        cpu_side_ports, "`slave` is now called `cpu_side_ports`"
    )
    mem_side_port = RequestPort("Port closer to memory side")
    master = DeprecatedParam(
        mem_side_port, "`master` is now called `mem_side_port`"
    )

    entry_type = Param.TypeTLB("Instruction/Data/Unified TLB entries")

    next_level = Param.BaseTLB(NULL, "next level")
